Skip to content

chore(wren-ai-service): improve text2sql#1846

Merged
cyyeh merged 1 commit intomainfrom
chore/ai-service/improve-text2sql
Jul 23, 2025
Merged

chore(wren-ai-service): improve text2sql#1846
cyyeh merged 1 commit intomainfrom
chore/ai-service/improve-text2sql

Conversation

@cyyeh
Copy link
Copy Markdown
Member

@cyyeh cyyeh commented Jul 23, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Updated instructions and rules for SQL generation to require inclusion of ranking columns and stricter use of ranking functions in generated SQL outputs.
    • Clarified and reordered reasoning steps for handling ranking problems.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jul 23, 2025 •
edited
Loading

Walkthrough

The changes revise the SQL generation reasoning system prompt and SQL rules to enforce stricter requirements for ranking problems. Instructions now mandate the use of DENSE_RANK(), filtering with a WHERE clause, and explicitly including the ranking column in the final SELECT statement. Reasoning steps are reordered and renumbered accordingly.

Changes

File(s) Change Summary
wren-ai-service/src/pipelines/generation/utils/sql.py Updated SQL reasoning system prompt and rules: strengthened ranking requirements, added explicit step for including ranking column, and reordered reasoning plan steps. No changes to function or class signatures.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SQLReasoner
    participant SQLGenerator

    User->>SQLReasoner: Request SQL for ranking problem
    SQLReasoner->>SQLGenerator: Generate SQL with enforced ranking rules
    SQLGenerator-->>SQLReasoner: SQL with DENSE_RANK(), WHERE filter, and ranking column in SELECT
    SQLReasoner-->>User: Return SQL with required ranking structure
Loading

Estimated code review effort

1 (~2 minutes)

Possibly related PRs

Suggested reviewers

  • yichieh-lu

Poem

In the land of SQL, where queries hop,
The ranking rules now never stop!
With DENSE_RANK we must comply,
And columns for rank we can’t deny.
A bunny’s code, precise and neat,
Ensures your rankings can’t be beat! 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 385e91d and 82b5e66.

📒 Files selected for processing (1)
  • wren-ai-service/src/pipelines/generation/utils/sql.py (2 hunks)
🧠 Learnings (1)
📓 Common learnings 
Learnt from: wwwy3y3
PR: Canner/WrenAI#1585
File: wren-ui/src/pages/api/v1/generate_sql.ts:98-106
Timestamp: 2025-04-24T16:10:43.308Z
Learning: In the generate_sql API, allow users to specify language codes not predefined in the WrenAILanguage enum, passing them through directly rather than strictly validating against the enum.
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings 
Learnt from: wwwy3y3
PR: Canner/WrenAI#1585
File: wren-ui/src/pages/api/v1/generate_sql.ts:98-106
Timestamp: 2025-04-24T16:10:43.308Z
Learning: In the generate_sql API, allow users to specify language codes not predefined in the WrenAILanguage enum, passing them through directly rather than strictly validating against the enum.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: pytest
🔇 Additional comments (2)
wren-ai-service/src/pipelines/generation/utils/sql.py (2)

188-199: Excellent improvements to ranking query consistency!

The changes strengthen the requirements for ranking problems by:

  1. Changing "should" to "must" to remove ambiguity
  2. Adding explicit requirement to include ranking column in SELECT clause
  3. Properly renumbering subsequent instructions

These modifications will help ensure more consistent and complete ranking query generation.

255-256: Great consistency between SQL rules and reasoning prompt!

The changes perfectly align the SQL generation rules with the updated reasoning prompt, ensuring consistent enforcement of ranking requirements throughout the text-to-SQL pipeline.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/ai-service/improve-text2sql

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@cyyeh cyyeh added module/ai-service ai-service related ci/ai-service ai-service related labels Jul 23, 2025
@cyyeh cyyeh requested a review from yichieh-lu July 23, 2025 02:52
@cyyeh cyyeh force-pushed the chore/ai-service/improve-text2sql branch from ef108e9 to 82b5e66 Compare July 23, 2025 02:54
@cyyeh cyyeh merged commit cbc154e into main Jul 23, 2025
11 of 12 checks passed
@cyyeh cyyeh deleted the chore/ai-service/improve-text2sql branch July 23, 2025 02:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yichieh-lu yichieh-lu yichieh-lu approved these changes

Assignees

No one assigned

Labels

ci/ai-service ai-service related module/ai-service ai-service related wren-ai-service

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cyyeh @yichieh-lu